Changing the default dedupe statuses behavior #622

sophiatev · 2026-01-21T01:47:25Z

Summary

Currently, only terminal statuses are reusable when creating a new orchestration with a given instance ID. This is enforced when creating the OrchestrationIdReusePolicy, which ensures that only terminal statuses are considered "reusable" (minus whatever statuses the user includes in the dedupe statuses passed to the creation call). This PR allows all statuses to be reusable, with the assumption that the server-side implementation will terminate an existing orchestration if it is running, pending, or suspended (in a non-terminal status) before creating a new one. This is a breaking change for which all server-side implementations will need to be updated accordingly:

This PR addresses the WebJobs implementation for the DF use-case.
DTS will need to be updated for the standalone SDK use-case to add the termination logic. However, the current backend implementation already does not allow creating a new orchestration if one exists in a non-terminal status, so changing the client-side implementation will not "break" anything until then.
Dapr sidecar, which forks this repo so it should be fine?

Project checklist

Release notes are not required for the next release
- Otherwise: Notes added to release_notes.md
Backport is not required
- Otherwise: Backport tracked by issue/PR #issue_or_pr
All required tests have been added/updated (unit tests, E2E tests)
Breaking change?
- If yes:
  - Impact: See summary
  - Migration guidance:

AI-assisted code disclosure (required)

Was an AI tool used? (select one)

No
Yes, AI helped write parts of this PR (e.g., GitHub Copilot)
Yes, an AI agent generated most of this PR

If AI was used:

Tool(s):
AI-assisted areas/files:
What you changed after AI output:

AI verification (required if AI was used):

I understand the code and can explain it
I verified referenced APIs/types exist and are correct
I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions)
I reviewed concurrency/async behavior
I checked for unintended breaking or behavior changes

Notes for reviewers

N/A

Copilot

Pull request overview

This PR changes the default behavior for orchestration ID reuse policies to allow all orchestration statuses to be reusable, rather than just terminal statuses. This is a breaking change that assumes server-side implementations will terminate existing orchestrations in non-terminal states before creating new ones with the same instance ID.

Changes:

Renamed GetTerminalStatuses() to GetAllStatuses() and expanded it to include non-terminal statuses (Pending, Running, Suspended)
Modified ConvertDedupeStatusesToReusePolicy() to return non-nullable policy and work with all statuses instead of just terminal ones
Updated all unit tests to reflect the new behavior and removed tests that validated non-terminal status filtering
Updated comments in server-side code to reflect the new semantics

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.

File	Description
src/Client/Grpc/ProtoUtils.cs	Renamed method to GetAllStatuses, added non-terminal statuses, changed return type to non-nullable, updated logic to handle all statuses
src/Client/Grpc/GrpcDurableTaskClient.cs	Refactored dedupe status handling using collection expressions, removed conditional policy assignment logic
src/InProcessTestHost/Sidecar/Grpc/TaskHubGrpcServer.cs	Updated comment to reflect "all statuses" instead of "terminal statuses"
test/Client/Grpc.Tests/ProtoUtilsTests.cs	Comprehensive test updates including renamed tests, updated assertions for all statuses, removed non-terminal filtering tests, added tests for new statuses

src/Client/Grpc/ProtoUtils.cs

src/Client/Grpc/GrpcDurableTaskClient.cs

test/Client/Grpc.Tests/ProtoUtilsTests.cs

sophiatev · 2026-01-26T20:03:33Z

src/Client/Core/DurableTaskClient.cs

-    /// may be recreated automatically, depending on the configuration of the backend instance store.
+    /// generated for you automatically. If an orchestration with the specified instance ID already exists and its status
+    /// is not in the <see cref="StartOrchestrationOptions.DedupeStatuses"/> field of <paramref name="options"/>, then
+    /// a new orchestration may be recreated automatically, depending on the configuration of the backend instance store.


What does "depending on the configuration of the backend instance store." in the existing method comment mean? Do not all backends support dedupe statuses?

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Comments suppressed due to low confidence (1)

src/InProcessTestHost/Sidecar/Grpc/TaskHubGrpcServer.cs:214

With the new semantics, making non-terminal statuses replaceable implies the server should terminate an existing non-terminal instance before creating the new one. This in-process gRPC server currently only converts the policy to dedupeStatuses and proceeds to create the orchestration, without any termination step, which can diverge from the intended behavior. Consider implementing the termination behavior here so the test host matches real backends.

        return Task.FromResult(new P.DeleteTaskHubResponse());
    }

    /// <summary>
    /// Starts a new orchestration instance.

test/Client/Grpc.Tests/ProtoUtilsTests.cs

src/Client/Grpc/ProtoUtils.cs

Copilot · 2026-01-26T20:05:35Z

src/Client/Grpc/ProtoUtils.cs

+    /// Gets an array of all orchestration statuses.
    /// These are the statuses that can be used in OrchestrationIdReusePolicy.
    /// </summary>
-    /// <returns>An immutable array of terminal orchestration statuses.</returns>
-    public static ImmutableArray<P.OrchestrationStatus> GetTerminalStatuses()
+    /// <returns>An immutable array of all orchestration statuses.</returns>
+    public static ImmutableArray<P.OrchestrationStatus> GetAllStatuses()


This change removes/renames public APIs in ProtoUtils (e.g., GetTerminalStatuses -> GetAllStatuses, nullable return types removed). If ProtoUtils is part of the public surface of Client.Grpc, this is a breaking change for SDK consumers beyond the server-side behavior change described in the PR. Consider keeping the old APIs as [Obsolete] shims (delegating to the new behavior) or explicitly calling out the API break in the PR summary/release notes.

This is a good point. Is this something we need to worry about?

src/Client/Core/DurableTaskClient.cs

sophiatev · 2026-01-26T20:07:37Z

src/Client/Grpc/GrpcDurableTaskClient.cs

-        }
+        // Convert dedupe statuses to protobuf statuses and create reuse policy
+        IEnumerable<P.OrchestrationStatus> dedupeStatusesProto = dedupeStatuses.Select(s => s.ToGrpcStatus());
+        request.OrchestrationIdReusePolicy = ProtoUtils.ConvertDedupeStatusesToReusePolicy(dedupeStatusesProto);


Do we want to add logic to wrap the "AlreadyExists" RpcException thrown if an orchestration already exists with a status in dedupe statuses?

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

src/Client/Grpc/ProtoUtils.cs

src/Client/OrchestrationServiceClientShim/ShimDurableTaskClient.cs

test/Client/OrchestrationServiceClientShim.Tests/ShimDurableTaskClientTests.cs

test/Client/Grpc.Tests/ProtoUtilsTests.cs

sophiatev · 2026-01-26T22:34:18Z

src/Client/Grpc/ProtoUtils.cs

+    /// <returns>An immutable array of all orchestration statuses.</returns>
+    public static ImmutableArray<P.OrchestrationStatus> GetAllStatuses()
    {
 #pragma warning disable CS0618 // Type or member is obsolete - Canceled is intentionally included for compatibility


Compatibility with what?

first commit?

8357e15

Copilot AI review requested due to automatic review settings January 21, 2026 01:47

Copilot started reviewing on behalf of sophiatev January 21, 2026 01:47 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

Sophia Tevosyan added 3 commits January 20, 2026 18:10

PR comments

b434062

Merge branch 'main' into stevosyan/remove-default-dedupe-statuses

b8fc30b

updating documentation

c54e0cb

Copilot AI review requested due to automatic review settings January 26, 2026 20:00

Copilot started reviewing on behalf of sophiatev January 26, 2026 20:00 View session

Merge branch 'main' into stevosyan/remove-default-dedupe-statuses

47bcb33

sophiatev commented Jan 26, 2026

View reviewed changes

Copilot AI reviewed Jan 26, 2026

View reviewed changes

sophiatev commented Jan 26, 2026

View reviewed changes

Sophia Tevosyan added 2 commits January 26, 2026 12:19

added implementation to shim client too

d8c26b3

added tests for the shim client

64c3ba9

Copilot AI review requested due to automatic review settings January 26, 2026 22:26

Copilot started reviewing on behalf of sophiatev January 26, 2026 22:27 View session

Copilot AI reviewed Jan 26, 2026

View reviewed changes

PR comments

796f522

sophiatev commented Jan 26, 2026

View reviewed changes

Changing the default dedupe statuses behavior #622

Are you sure you want to change the base?

Changing the default dedupe statuses behavior #622

Uh oh!

Conversation

sophiatev commented Jan 21, 2026

Summary

Project checklist

AI-assisted code disclosure (required)

Was an AI tool used? (select one)

Notes for reviewers

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sophiatev Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

sophiatev Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sophiatev Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sophiatev Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants